Get Event Details
Route
/v2/event-details
Description
Retrieve detailed information about specific events using event IDs. Events represent data movement activities captured by Cyberhaven sensors.
Method
POST (Recommended) | GET | GET with path parameters
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array[string] | Yes | Array of event IDs to retrieve (max 100) |
include_content | boolean | No | Include content analysis results in response |
Request Methods
POST (Recommended)
{
"ids": ["event-123", "event-456"],
"include_content": true
}
GET with Query Parameters
GET /v2/event-details?ids=event-123&ids=event-456&include_content=true
GET with Path Parameters
GET /v2/event-details/event-123,event-456
Output
| Field | Type | Description |
|---|---|---|
type | string | Always "events" |
size | integer | Number of events returned |
resources | array[Event] | Array of event objects |
errors | array[Error] | Any errors encountered |
Event Object Structure
| Field | Type | Description |
|---|---|---|
id | string | Unique event identifier |
timestamp | string | Event timestamp (ISO 8601) |
action | Action | Action details and context |
user | EventUser | User who performed the action |
source | Location | Source location of the data |
destination | Location | Destination location of the data |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response
{
"type": "events",
"size": 2,
"resources": [
{
"id": "event-123",
"timestamp": "2024-01-15T10:30:00Z",
"action": {
"kind": "upload",
"blocked": false,
"data_size": 1024
},
"user": {
"id": "user-456",
"local_username": "john.doe"
},
"source": {
"file": {
"name": "document.pdf",
"size": 1024
}
},
"destination": {
"web": {
"domain": "drive.google.com"
}
}
}
],
"errors": []
}